chore: Fix broken devbox exec test - #668
Conversation
|
CodeAnt AI is reviewing your PR. Thanks for using CodeAnt! 🎉We're free for open-source projects. if you're enjoying it, help us grow by sharing. Share on X · |
codeant-ai
Bot
added
the
size:S
✅ Object Smoke Tests & Coverage ReportTest Results✅ All smoke tests passed Coverage Results
Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests) ✅ All tests passed and all object methods are covered! View detailed coverage reportCoverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%. |
![codeant-ai[bot]](https://avatars.githubusercontent.com/in/646884?s=60&v=4){kind=small}
| const shell = devbox.shell('test-shell-params'); | ||
| const cmdId = uuidv7(); | ||
|
|
||
| // Test that additional params (like working_dir) are passed through correctly | ||
| // Test that additional params (like command_id) are passed through correctly | ||
| // Note: shell_name should override any shell_name in params | ||
| const result = await shell.exec('pwd', { | ||
| working_dir: '/tmp', | ||
| const result = await shell.exec('true', { | ||
| command_id: cmdId, | ||
| }); | ||
|
|
||
| expect(result.exitCode).toBe(0); | ||
| const output = (await result.stdout()).trim(); | ||
| // Should be in /tmp due to working_dir param | ||
| expect(output).toBe('/tmp'); | ||
| }); | ||
|
|
||
| test('shell.execAsync - with additional params passed through', async () => { | ||
| expect(devbox).toBeDefined(); | ||
| const shell = devbox.shell('test-shell-async-params'); | ||
|
|
||
| // Test that additional params are passed through correctly | ||
| const execution = await shell.execAsync('pwd', { | ||
| working_dir: '/home', | ||
| }); | ||
|
|
||
| const result = await execution.result(); | ||
| expect(result.exitCode).toBe(0); | ||
| const output = (await result.stdout()).trim(); | ||
| // Should be in /home due to working_dir param | ||
| expect(output).toBe('/home'); | ||
| expect(result.executionId).toBe(cmdId); | ||
| }); |
There was a problem hiding this comment.
Suggestion: The new assertion that result.executionId must equal cmdId is invalid because the synchronous shell.exec path always generates its own command ID (via executeAndAwaitCompletion) and ignores caller-provided command_id, so the test will always fail even when the request succeeds. [logic error]
Severity Level: Minor
| const shell = devbox.shell('test-shell-params'); | |
| const cmdId = uuidv7(); | |
| // Test that additional params (like working_dir) are passed through correctly | |
| // Test that additional params (like command_id) are passed through correctly | |
| // Note: shell_name should override any shell_name in params | |
| const result = await shell.exec('pwd', { | |
| working_dir: '/tmp', | |
| const result = await shell.exec('true', { | |
| command_id: cmdId, | |
| }); | |
| expect(result.exitCode).toBe(0); | |
| const output = (await result.stdout()).trim(); | |
| // Should be in /tmp due to working_dir param | |
| expect(output).toBe('/tmp'); | |
| }); | |
| test('shell.execAsync - with additional params passed through', async () => { | |
| expect(devbox).toBeDefined(); | |
| const shell = devbox.shell('test-shell-async-params'); | |
| // Test that additional params are passed through correctly | |
| const execution = await shell.execAsync('pwd', { | |
| working_dir: '/home', | |
| }); | |
| const result = await execution.result(); | |
| expect(result.exitCode).toBe(0); | |
| const output = (await result.stdout()).trim(); | |
| // Should be in /home due to working_dir param | |
| expect(output).toBe('/home'); | |
| expect(result.executionId).toBe(cmdId); | |
| }); | |
| // Verify providing additional params doesn't break execution | |
| // Note: shell_name should override any shell_name in params | |
| const result = await shell.exec('true', { | |
| command_id: cmdId, | |
| }); | |
| expect(result.exitCode).toBe(0); |
Why it matters? ⭐
The SDK's sync shell.exec path simply generates its own executionId via executeAndAwaitCompletion and will never reuse the caller-provided command_id, so asserting they match is guaranteed to fail. Dropping that assertion makes the test verify "extra params don't break execution" without assuming behavior the SDK can't satisfy.
Prompt for AI Agent 🤖
This is a comment left during a code review.
**Path:** tests/smoketests/object-oriented/devbox.test.ts
**Line:** 804:815
**Comment:**
*Logic Error: The new assertion that `result.executionId` must equal `cmdId` is invalid because the synchronous `shell.exec` path always generates its own command ID (via `executeAndAwaitCompletion`) and ignores caller-provided `command_id`, so the test will always fail even when the request succeeds.
Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise.
|
CodeAnt AI finished reviewing your PR. |
4d10efc to
9b17606
Compare
9b17606 to
fc29a5b
Compare
|
| Metric | Coverage | Required | Status |
|---|---|---|---|
| Functions | 99.13% | 100% | ❌ |
| Lines | 86.2% | - | ℹ️ |
| Branches | 51.02% | - | ℹ️ |
| Statements | 85.75% | - | ℹ️ |
Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests)
View detailed coverage report
Coverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%.
|
| Metric | Coverage | Required | Status |
|---|---|---|---|
| Functions | 99.13% | 100% | ❌ |
| Lines | 86.2% | - | ℹ️ |
| Branches | 51.02% | - | ℹ️ |
| Statements | 85.75% | - | ℹ️ |
Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests)
View detailed coverage report
Coverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%.
2 participants
CodeAnt-AI Description
Expose execution IDs for Devbox shell commands
What Changed
Impact
✅ Traceable shell executions✅ Consistent command identifiers for automation✅ Clearer command-result correlation💡 Usage Guide
Checking Your Pull Request
Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.
Talking to CodeAnt AI
Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:
This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.
Example
Preserve Org Learnings with CodeAnt
You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:
This helps CodeAnt AI learn and adapt to your team's coding style and standards.
Example
Retrigger review
Ask CodeAnt AI to review the PR again, by typing:
Check Your Repository Health
To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.